.TH "Zebulon::GeneticAlgorithms::Settings" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::GeneticAlgorithms::Settings \- 
.PP
Structure for storing settings information used in the evolution process.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <settings.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBCrossover\fP"
.br
.RI "\fI\fBCrossover\fP settings. \fP"
.ti -1c
.RI "class \fBMutation\fP"
.br
.RI "\fI\fBMutation\fP settings. \fP"
.ti -1c
.RI "class \fBSelection\fP"
.br
.RI "\fISelections settings. \fP"
.ti -1c
.RI "class \fBSpecies\fP"
.br
.RI "\fI\fBSpecies\fP settings. \fP"
.ti -1c
.RI "class \fBTournament\fP"
.br
.RI "\fIData used within the \fBTournament\fP \fBSelection\fP method. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSettings\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~Settings\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "bool \fBLoadSettings\fP (const std::string &xmlFile)"
.br
.RI "\fILoads GA Evolution settings from an XML file. \fP"
.ti -1c
.RI "void \fBClear\fP ()"
.br
.RI "\fIClears data (resets to defaults). \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "Mutation::Set \fBmMutations\fP"
.br
.RI "\fIMutations to apply during evolution. \fP"
.ti -1c
.RI "\fBCrossover\fP \fBmCrossoverMethod\fP"
.br
.RI "\fI\fBCrossover\fP method to use. \fP"
.ti -1c
.RI "Selection::Type \fBmSelectionMethod\fP"
.br
.RI "\fI\fBSelection\fP method to use for offspring. \fP"
.ti -1c
.RI "\fBSelection\fP * \fBmSelectionMethodData\fP"
.br
.RI "\fIAdditional selection method data (Optional). \fP"
.ti -1c
.RI "\fBSpecies\fP \fBmSpecies\fP"
.br
.RI "\fISpeciation information. \fP"
.ti -1c
.RI "unsigned int \fBmPopulationSize\fP"
.br
.RI "\fISize of the population. \fP"
.ti -1c
.RI "unsigned int \fBmNumberOfGenerations\fP"
.br
.RI "\fINumber of generations per run. \fP"
.ti -1c
.RI "unsigned int \fBmNumberOfRuns\fP"
.br
.RI "\fITotal number of runs. \fP"
.ti -1c
.RI "unsigned int \fBmMaxChromosomeSize\fP"
.br
.RI "\fIMaximum chromosome size. \fP"
.ti -1c
.RI "unsigned int \fBmElitismCount\fP"
.br
.RI "\fINumber of parents to survive to next generation unchanged. \fP"
.ti -1c
.RI "bool \fBmLoggingFlag\fP"
.br
.RI "\fIEnable logging. \fP"
.ti -1c
.RI "std::string \fBmBestSolutionDir\fP"
.br
.RI "\fIDirectory to save best solutions to. \fP"
.ti -1c
.RI "std::string \fBmBestFitnessFilename\fP"
.br
.RI "\fIBest fitness log filename. \fP"
.ti -1c
.RI "std::string \fBmAverageFitnessFilename\fP"
.br
.RI "\fIAverage fitness log filename. \fP"
.ti -1c
.RI "std::string \fBmAdditionalDataFilename\fP"
.br
.RI "\fIAdditional settings data filename. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Structure for storing settings information used in the evolution process. 

\fBSettings\fP can load evolution configuration data from an XML file so that different evolutionary configurations can be used without the need to recompile a program. 
.SH "Member Function Documentation"
.PP 
.SS "bool Settings::LoadSettings (const std::string & xmlFile)"
.PP
Loads GA Evolution settings from an XML file. \fBParameters:\fP
.RS 4
\fIxmlFile\fP Filname of XML data to read from.
.RE
.PP
\fBReturns:\fP
.RS 4
True on success, false on failure. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
